OpenPlant Modeler Help

OpenPlant Configuration Variables

OpenPlant Configuration Variables

Below is a list of available configuration variables which control various OpenPlant functions and procedures.

Autofitting

Config Variable Value Definition
OPM_SUPPORTED_MIN_ANGLE 1 Defines the min angle for placement of pipebends and trimmed elbows
OPM_SUPPORTED_ANGLES 0,45,60,90 List of angles supported for component placement in autofitting
OPM_SUPPORTED_ANGLE_TOLERANCE 2.5 Tolerance for exactly matching the bend angles
OPM_MISALIGNMENT_ALLOWANCE 10 The OPM_MISALIGNMENT_ALLOWANCE variable is an angular tolerance value for allowing the AutoFitting routine to dynamically place a rigid fitting at a non-exact angle when the user-interface toggle Allow Misaligned Fittings is ON. This toggle is useful for a dynamically placed sloped pipeline to place rigid, though slightly misaligned, branch fittings and bends. The angular value is applied (+/-) to both sides of the dynamically misaligned connection.
OPM_AUTOFITTING_TRIM_STOCK_ANGLES 90;45 Default elbow angle types for trimmed elbows supported in AutoFitting
OPM_AUTOFITTING_ELBOW_TYPES LongRadius;ShortRadius;3R List of elbow types supported by Autofitting
OPM_HVAC_AUTOFITTING_GENERICCOMPONENT 1 To place generic/custom component if we don not find that component in spec

Component Placement

Config Variable Value Definition
OPM_MIN_ANGLE_FOR_MITERED_ELBOWS 30 Default Min angle limit for mitered elbows
OPM_MAX_ANGLE_FOR_MITERED_ELBOWS 90 Default Max angle limit for mitered elbows
OPM_REPLACE_BEND_KEEP_BEND_RADIUS 1 When value set to 1, this variable will preserve the pipe bend radius or pipe bend radius factor on existing bend components during the Change Size/Change Spec function
OPM_QUICK_REPLACE 1 Enables to disables the appearance of the replace component option on the right click menu. A value of 0 means no menu pick. 1 means to show the menu pick
OPM_HOOKUP_TOOL_ANGLES_FILE ${OPM_USER}/HookupAngles.xml hookup tool angle xml location
OPM_HEAL_ON_DELETE 1 Enable or disable the pipe healing on component deletion
OPM_HEAL_MAX_DELETED 30 Max no. of component deletion to invoke the pipe healing
OPM_GEN_BRANCH_MIN_ANGLE_DIFF 45 Min allowable angle between Main/Run and Branch to avoid the overlapping cylinders
OPM_ATTRIBUTESTOCHECK NOMINAL_DIAMETER List of mandatory properties that should be matched between the mating components
OPM_MINIMUM_PIPE_LENGTH 0,1

Sets the minimum pipe length for the pipe. For Example,

if the value is set to 1,1 it means all the pipes with a diameter greater than or equal to 1 will have minimum length = 1 in.

It supports multiple semi-colons separated settings

OPM_MINIMUM_BRANCH_PLACMENT_FACTOR 1

Decides the minimum distance from a pipe end for tap placement.

Tap connection / Auto branch on : minimum distance now is calculated as:

minimum distance = BranchPipeDiameter / 2 x factor

If the factor is set to 0, OpenPlant Modeler will allow the tap placement even on the end of pipe
OPM_ALLOW_MULTI_PIPELINE_ISOSHEET 1 Generates single IsoSheet for multiple pipelines.

Connectivity

Config Variable Value Description
OPM_USE_ATTRIBUTESTOCHECK_VAR_FOR_REPLACEMENT 0 Is used by replace command to refine replacement list; if the variable value is set to 1, replace command will use all properties defined by OPM_ATTRIBUTESTOCHECK and End Preparation property to filter out components.
OPM_TRAY_OPTIONAL_ATTRIBUTESTOCHECK SPECIFICATION list of optional properties that should be matched between mating components
OPM_TRAY_ATTRIBUTESTOCHECK NOMINAL_WIDTH;NOMINAL_HEIGHT List of mandatory properties that should be matched between the mating components
OPM_CALCULATE_BOLT_LENGTH 1

If it is set to 1 then will calculate bolt length and if it is set to 0 then will not calculate bolt length and instead will show from spec to choose, by default it is set to 1.

ALLOW_BOLT_INCREMENTING 1 Calculates the bolt length if no bolt reaches the calculated bolt length from the spec.
Note: Spec must be reloaded in the Standard Preferences after this option is changed.
OPM_QUERY_BOLTS_WITH_IGNORE_LENGTH 0 Ignore Bolt Length when getting spec records.
Note: This variable is only used when the OPM_CALCULATE_BOLT_LENGTH variable is not defined.
OPM_OPTIONAL_ATTRIBUTESTOCHECK SPECIFICATION list of optional properties that should be matched between mating components
OPM_OPENEND_SEARCH_FACTOR 0.5 is factor multiplied to Nominal Diameter to search for open ports near a given port in connectivity checker.
OPM_MATCH_PROPERTY_MAP_RATING CL150;CL125|CL250;CL300|PN25;

PN40|PN10;PN16

List of compatible rating values for mating components
OPM_MATCH_PROPERTY_MAP_FACING C;D|E;F Pair of facing values are compatible with each other
OPM_FLANGE_JOINT_TOLERANCE 0.25 Define the max gap length between the matting flanges in PSDS or PDx dgn to consider it for a flange joint
OPM_DEFAULT_WELD_TYPE SHOP Default weld type to be used for component connection
OPM_DEFAULT_WELD_SPHERE_RADIUS 0.2 Size of the weld symbol
OPM_DEFAULT_WELD_LENGTH 0 default weld gap
OPM_CONNECTIVITY_TOLERANCE 0.05 Allowable gap between the mating ports for a valid joint between them
OPM_ALIGNMENT_TOLERANCE 1 Angular tolerance in Degrees between the mating port
OPM_EXTENDED_JOINT_TOLERANCE MEGA_LUG_JOINT,1.5;GROOVE_JOINT,1.57

Controls Joint Tolerance of specific joints in connectivity checker. It support multiple semi colon separated settings.

First value is JOINT NAME and second is TOLERANCE.

Tolerance value should be greater than distance between the two components whose connection needs to be fixed.

To use this variable uncomment it in Modeler.cfg.

OPM_USE_FASTENERS_BASED_ON_CONNECTION True
  • If set to True then forced to use connection based fasteners only.
  • If set to False then connections are made using mapping config variable.

Equipment/Nozzle Manager

Config Variable Value Description
OPM_RANGE_BOX_EXPAND_PERCENTAGE 15 The OPM_RANGE_BOX_EXPAND_PERCENTAGE specifies the percentage of expansion desired in the range bounding box that replaces the existing graphics of a user-defined equipment during the Drop command
OPM_EQUIP_TEMPLATES ${OPM_USER}/equip_templates/ Location for the Equipment templates
OPM_NOZMGR_TRY_TYPE_ORDER Axial Order of nozzle types appear in nozzle manager
OPM_NOZMGR_TRANSPARENCY_PERCENTAGE 70 Value of transparence
OPM_NOZMGR_TEMPLATES ${OPM_USER}/nozzle_templates/ Location for the nozzle manager template
OPM_NOZMGR_SUPPRESS_GRID_DATA_VALIDATION Y Suppress the runtime validation of the data entered
OPM_NOZMGR_SHOW_TYPE_DIAGRAM Y Show Type diagram
OPM_NOZMGR_SHOW_EQUIP_TRANSPARENT Y Make equipment transparent
OPM_NOZMGR_SHOW_DATUM Y Show Datum
OPM_NOZMGR_REQUIRE_SYSTEM N Nozzle require system
OPM_NOZMGR_REQUIRE_LINENUMBER N Nozzle require line number
OPM_NOZMGR_HIGHLIGHT_CURRENT_EQUIPMENT Y Highlight current equipment
OPM_NOZMGR_DECIMAL_SEPARATOR . Decimal separate symbol
OPM_NOZMGR_DECIMAL_PLACES 3 No. of digits show after decimal
OPM_NOZMGR_DATUM_WEIGHT 5 Line weight of the datum graphics
OPM_NOZMGR_DATUM_LEVEL ReservedForNozzleManager Level assigned to the datum
OPM_NOZMGR_DATUM_COLOR_Z 1 Datum Z Axis color
OPM_NOZMGR_DATUM_COLOR_Y 3 Datum Y Axis color
OPM_NOZMGR_COPY_SPECNOZZLE_PROPERTIES DEVICE_TYPE_CODE Copy properties

OPM_CUSTOM_EQUIP_CONVERT_TO_NONPARAMETRIC

OPM_CUSTOM_EQUIP_PROCESS_PARAMETRIC_SOLIDS

0

1

Retains and modifies the Parametric Solid Features When Custom Equipment is Dropped.
Note: Applicable only for Modeler Standalone workflows.

OPIM

Config Variable Value Description
OPIM_QUANTITY_FOR_CONNECTIVITY LENGTH Dimension for connectivity
OPIM_ISOMETRIC_WORKFILE_ROOT $(_USTN_PROJECTWORKFILES)Isometrics/ root folder for isometric work files
OPIM_ISOMETRIC_DATASET_ROOT $(_USTN_PROJECTDATASET)Isometrics Root folder where Isometric related settings are stored
OPIM_ISO_USER_GROUP ISOProduction Isomeric User group
OPIM_CONNECTIVITY_TOLERANCE $(OPM_CONNECTIVITY_TOLERANCE) Connectivity Tolerance for Isometrics

Project Attributes and Schema

Config Variable Value Description
_USTN_PROJECTWORKFILES (_USTN_PROJECTDATA)

WorkFiles/

Project Workfile location
_USTN_PROJECTNAME OPModeler_Imperial Project Name
_USTN_PROJECTDESCR OpenPlant

Modeler

Sample

Imperial

Project

Project Description
_USTN_PROJECTDATASET $(_USTN_PROJECTDATA)

Dataset/

point to the location of the OpenPlant 3D Dataset folder
PROJ_MASTER_UNIT FEET Defines Project Master Units for ISO generation
PROJECTWISE_DATASOURCE   specify list of datasources separated by ;
OPM_SUPPLEMENTAL_SCHEMA OpenPlant_3D_Supplemental_Imperial_DefaultValues.01.04 Supplemental schema for OpenPlant Modeler Primary schema
OPM_PRIMARY_SCHEMA OpenPlant_3D.01.04 OpenPlant Modeler Primary Schema name
OPM_DIR_SCHEMAS $(_USTN_PROJECTDATASET)

Schemas/

List the path of all schema files
OPIM_SCHEMA_PATH $(OPM_DIR_SCHEMAS) Schema Storage location
OPIM_SCHEMA_LIST Bentley_Building_CustomAttributes.01.00 OPIM schema list
OPIM_PRIMARY_SCHEMA $(OPM_PRIMARY_SCHEMA) OPIM Primary schema name

Schema

Config Variable Value Description
OPM_SUPPLEMENTAL_SCHEMA OpenPlant_3D_Supplemental_Imperial_DefaultValues.01.04 Supplemental schema for OpenPlant Modeler Primary schema
OPM_PRIMARY_SCHEMA OpenPlant_3D.01.04 OpenPlant Modeler Primary Schema name
OPM_DIR_SCHEMAS $(_USTN_PROJECTDATASET)

Schemas/

List the path of all schema files
OPIM_SCHEMA_PATH $(OPM_DIR_SCHEMAS) Schema Storage location
OPIM_SCHEMA_LIST Bentley_Building_CustomAttributes.01.00 OpenPlant Modeler schema list
OPIM_PRIMARY_SCHEMA $(OPM_PRIMARY_SCHEMA) OpenPlant Modeler Primary schema name
OP3D_SUPPLEMENTAL_UNIT_SCHEMA OpenPlant_3D_Supplemental_Units
  • Sets the name of OpenPlant_3D Supplemental Unit schema.
  • If it is not defined default name will be used.
OP_SUPPLEMENTAL_UNIT_SCHEMA OpenPlant_Supplemental_Units
  • Sets the name of OpenPlant Supplemental Unit schema.
  • If it is not defined default name will be used.

PlantSight

Config Variable Value Description
OP_PLANTSIGHT_REFERENCE_ONLY_SUPPORT ENABLED Determines the actions when connection to a PlantSight iModel with a file that has components checked out to another briefcase.

Default is ENABLED-allow the current user to open the file for editing but they will not be able to commit any changes

OFFLINE- This will force the user to work in an offline mode. No PlantSight functions will be available

Exit- The session will exit

OPM_LEAVE_REF_COPY_ON_CHECKIN 1 - Leave copy of components

0 - Clear copy of components

Determines whether to leave referenced copy of components in the drawing.
OPM_UPDATE_SYMBOLOGY_FOR_REFOUT 1 - Reference components different color

0 - Referenced components same color

Change color of referenced components
OPM_REFOUT_SYMBOLOGY_COLOR 14 (gray) defines color of referenced out components
OP_IMODEL_OFFLINE_DIALOG 1 Controls display of error dialog which displays when opening a connect drawing while not connected to PlantSight
OPM_CM_IGNORE_OP3D_CATALOGUE_ATTRIBUTE_PROPERTIES 1 Ignores catalog restriction in Consistency Manager differencing
OPM_SUPPRESS_COMMIT_PROMPTS 1 Suppresses all dialogs when checking in model from OpenPlant Modeler

Set to 0 to display the dialogs during the check-in process.

OPM_SUPPRESS_COMMIT_COMMENTS_PROMPT 1 Suppresses the Commit Comments dialog during the PlantSight checkin process.
Note: This variable only affects the Commit Message dialog when the OPM_SUPPRESS_COMMIT_PROMPTS variable shown above is not enabled. Otherwise, all prompts and dialogs are suppressed.
OP_TAG_BROWSER_CONFIGURATION_MAPPING_FILE_NAME $(OPENPLANT_WORKSET_STANDARDS)Mapping\MappingsTagClass.json Tag Browser mapping file name and location
OPM_PS_TREE_ENABLE_QUICK_MODE 1 Reduces the time required for exploring PlantSight nodes.

Project Seed files and Library files

Config Variable Value Description
MS_SYMBRSRC $(_USTN_PROJECTDATASET)

Symb/*.rsc

List of RSC files defining the symbology for the project
MS_SEEDFILES $(_USTN_PROJECTDATASET)

Seed/

Seed file used to create new DGN models for the Project
MS_DGNLIBLIST $(_USTN_PROJECTDATASET)

Dgnlibs/*.dgnlib

Dgnlibs used by OpenPlant Modeler. This variable is a list so we will append our project Dgnlibs to the list. We will use a * to indicate that all dgnlibs in the dataset Dgnlibs folder will be loaded.
MS_DESIGNSEED pmseed3d.dgn Seed file used to create new DGN models for the Project.
MS_DEF $(_USTN_PROJECTDATA)

WorkFiles/models/

Default location of project's dgn files.
MS_CELL $(_USTN_PROJECTDATASET)

Cell/

Project Cell libraries location

Misc

Config Variable Value Description
OPM_TRAY_SEGMENT_GENERATION_ATTRIBUTES NOMINAL_WIDTH;

NOMINAL_HEIGHT;SPECIFICATION

List of properties that define the position where one Segment stops and the next starts
OPM_SHOW_SEGMENTS 1 Variable to control the display of the piping segment tab in UI.
OPM_SEGMENT_GENERATION_ATTRIBUTES NOMINAL_DIAMETER;SPECIFICATION Semicolon separated list of properties which should be same among component belonging to one segment
OPM_FILE_STANDARD_PREF_DB $(_USTN_PROJECTDATASET)Settings/

stdprefs.accdb

Defines the database that be used to setup pick list and other items in the standard preferences dialog.
OPM_DATASET_SETTINGS $(_USTN_PROJECTDATASET)Settings/ Defines the database that be used to setup pick list and other items in the standard preferences dialog.
OPM_DO_NOT_CHANGE_NUMBER_PROPERTY_ONCOPY 1 or true Restricts to update number property on copy operation for referenced DGN components. So tag remains same when you copy component from reference DGN. You can define this variable in session and restart the session or beforehand in cfg.
OPM_DATASET_SETTINGS $(_USTN_PROJECTDATASET)Settings/ Defines the database that be used to setup pick list and other items in the standard preferences dialog.
OPM_MODELS_SCANNING_FILTER ALL Controls the loading of referenced DGNs' pipelines inside pipeline manager. Also controls component placement.

If set to ALL Components can be placed from/into the referenced dgn's components. Pipeline manager shows the referenced pipelines with all the models, attached referenced models and their children as well

If set to ACTIVE then only current model will be used during scan of the components when making connections. Doesn't allow placing components from/into the referenced dgn's components. And only current model will be loaded in pipeline manager.

Spec settings

Config Variable Value Description
OPM_USE_DEFAULT_SPEC_CHOICE 0 Default Spec Choice, 0 = false, 1 = true
OPM_SPECVALIDATION_ATTRIBUTESTOCHECK NOMINAL_DIAMETER;RATING;

SHORT_DESCRIPTION;DESCRIPTION;

MATERIAL;MANUFACTURER;

CODE;RATING

The OPM_SPECVALIDATION_ATTRIBUTESTOCHECK variable is a semicolon seperated list of Properties that are checked against the spec properties when using the Spec Check tools.
OPM_SPECS_PLUGIN_DATABASES $(_USTN_PROJECTDATASET)

MappingDatabases/

Mapping databases location
OPM_SPECPLUGIN_PSDS_UNITS MM Units for PSDS Spec
OPM_SPECPLUGIN_PDX_UNITS MM Units for PDx Spec
OPM_SPECPLUGIN_PDX_STANDARDS AMS;DIN Standard type of PDx spec
OPM_SPECPLUGIN_CURRENTSOURCE OPM Default spec mode selection option
OPM_DIR_SPECS $(_USTN_PROJECTDATASET)

SpecsDatabases/

Spec Database location
OPM_SPECPLUGIN_OPM_UNITS IN Unit type of spec database
OPM_SPECPLUGIN_OPM_DIM_CONVERSIONFACTOR 1 Factor for converting ND values in dimensional values in scripts

Deprecated Variables

The following configuration variables have been deprecated.

Config Variable Value Description
OPMS_DEFAULT_CONNECT_MODE
OPMS_STATIC_QUERY_PATH
OPMS_RUN_IN_GUID_AUTOFIX_MODE
OPMS_PROJECT_REPOSITORY_NAME
OPMS_SUPPLEMENTAL_SCHEMA
PDX_ENABLED 1 Do validity check for PDx native format elements for OpenPlant ModelServer checkin, should be set to 1 for all PDx conversion projects
OPM_RELATE_UNITS_TO_EQUIPMENT 1 Relate Unit to Equipment
OPM_PDX_UPGRADE_LOW_PRIORITY_CLASSES NOZZLE;OLET List of component which should be processed at the end during the PDx Upgrade
OPM_PDX_UPGRADE_HIGH_PRIORITY_CLASSES PIPE List of the ciomponents which should be processed first during PDx upgrade process
OPM_PDX_UNREINFORCED_BRANCH_TAG UBR_STUB_IN Branch Tag for PDx components mapped with Unreinforced EC Class
OPM_PDX_REINFORCED_BRANCH_TAG RBR_STUB_IN Branch Tag for PDx components mapped with Reinforced EC Class
OPM_PDX_CONVERT_SKIP CONTROL_VALVE List of components that sould be skipped during the PDx convert process
OPM_PDX_CONVERSION_SPEC_QUERIES 1 Skip the spec querying for PDx convert process
OPM_NOZZLE_TAG_UPGRADE False Nozzle tag upgrade process during PDx upgrade
OPM_EQUIPMENT_UNIT_PROPERTY_NAME UNIT Unit property name for the equipment
OPM_DELETE_ORPHAN_CELLS_DURING_UPGRADE 0 Controls the the deletion of orphan cells in an upgrade process
MS_PDXMANAGER_PDS_RDB_STD_NOTE us_stdnote.l Name of the standard note library for PDx Spec
MS_PDXMANAGER_PDS_RDB_PJSTB us_pjstb.l Name of pjstb type file of PDx spec
MS_PDXMANAGER_PDS_RDB_PCDIM us_pcdim.l Name of PCIM type file of PDx Spec
Config Variable Value Description
OPR_REPORT_TREE_DEFINITIONS $(OPM_REPORT_DATASET_ROOT)

TreeDefinition/

OpenPlant Modeler Reporting setup file location
OPR_REPORT_REPORT_DEFINITIONS $(OPM_REPORT_DATASET_ROOT)

ReportDefinition/

OpenPlant Modeler Reporting setup file location
OPR_REPORT_DATASET_ROOT $(_USTN_PROJECTDATASET)

Reports/

OpenPlant Modeler Reporting setup file location
OPR_REPORT_CRYSTAL_TEMPLATES $(OPM_REPORT_DATASET_ROOT)

CrystalTemplates/

OpenPlant Modeler Reporting setup file location
OPM_REPORT_TREE_DEFINITIONS $(OPM_REPORT_DATASET_ROOT)TreeDefinition/ Report Tree definition
OPM_REPORT_REPORT_DEFINITIONS $(OPM_REPORT_DATASET_ROOT)

ReportDefinition_opm/

Report definition
OPM_REPORT_OUTPUT $(_USTN_PROJECTWORKFILES)

Reports/

Report Output location
OPM_REPORT_DATASET_ROOT $(_USTN_PROJECTDATASET)

Reports/

OpenPlant Modeler Report tools location
OPM_REPORT_CRYSTAL_TEMPLATES $(OPM_REPORT_DATASET_ROOT)

CrystalTemplates_opm/

Crystal report template location
OPM_REPORT_CELL_TEMPLATES $(OPM_REPORT_DATASET_ROOT)

Cell/

Cell template location for Reports
OPM_AREA_REPORTING_REPORT_TEMPLATE_NAME CenterlineReportTemplate Area report template name
OPM_AREA_REPORTING_OUTPUT_PATH $(OPM_REPORT_OUTPUT) Area report output location